Content Library Subscriptions CreateSpecSubscribedLibrary

The Content Library Subscriptions CreateSpecSubscribedLibrary schema defines the subscribed library information used to create the subscription.

This schema was added in vSphere API 6.7.2.

JSON Example

{
    "target": "string",
    "new_subscribed_library": {
        "name": "string",
        "description": "string",
        "storage_backings": [
            {
                "type": "string",
                "datastore_id": "string",
                "storage_uri": "string"
            }
        ],
        "automatic_sync_enabled": false,
        "on_demand": false
    },
    "subscribed_library": "string",
    "location": "string",
    "vcenter": {
        "hostname": "string",
        "https_port": 0
    },
    "placement": {
        "folder": "string",
        "cluster": "string",
        "resource_pool": "string",
        "host": "string",
        "network": "string"
    }
}

string

target

Required

Specifies whether the target subscribed library should be newly created or an existing subscribed library should be used.

For more information see: Content Library Subscriptions CreateSpecSubscribedLibrary Target.

This property was added in vSphere API 6.7.2.

new_subscribed_library

Optional

Specification for creating a new subscribed library associated with the subscription.

This property was added in vSphere API 6.7.2.

This property is optional and it is only relevant when the value of target is Content Library Subscriptions CreateSpecSubscribedLibrary Target.CREATE_NEW.

string

subscribed_library

Optional

Identifier of the existing subscribed library to associate with the subscription. Only the subscribed libraries for which Content Library SubscriptionInfo.subscription_url property is set to the Content Library PublishInfo.publish_url of the published library can be associated with the subscription.

This property was added in vSphere API 6.7.2.

This property is optional and it is only relevant when the value of target is Content Library Subscriptions CreateSpecSubscribedLibrary Target.USE_EXISTING.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.content.Library. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.content.Library.

string

location

Required

Location of the subscribed library relative to the published library.

For more information see: Content Library Subscriptions Location.

This property was added in vSphere API 6.7.2.

vcenter

Optional

Specification for the subscribed library's vCenter Server instance.

This property was added in vSphere API 6.7.2.

This property is optional and it is only relevant when the value of location is Content Library Subscriptions Location.REMOTE.

placement

Optional

Placement specification for the virtual machine template library items on the subscribed library.

This property was added in vSphere API 6.7.2.

This property is currently required. In future, if this is missing or null, the system will attempt to choose a suitable placement specification for the virtual machine template items; if a placement specification cannot be chosen, publish of virtual machine template items will fail.